Skip to content

Update transaction pipelining docs re: parallelism #20314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Oct 21, 2025
Merged

Update transaction pipelining docs re: parallelism #20314

merged 2 commits into from
Oct 21, 2025

Conversation

rmloveland
Copy link
Contributor

Fixes DOC-8591

Specifically, we state that the cost of writes is ~O(1) in the number of inserts, which is misleading. The reality is that despite the parallelism introduced by pipelining, there is other work that happens for each write that does not come "for free".

@rmloveland rmloveland marked this pull request as draft September 9, 2025 20:09
@netlify
Copy link

netlify bot commented Sep 9, 2025 •
edited
Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit de54394
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/68f7de6363388c0008e5692f

@netlify
Copy link

netlify bot commented Sep 9, 2025 •
edited
Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit de54394
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/68f7de65b7fb390008e5d884

@github-actions
Copy link

github-actions bot commented Sep 9, 2025 •
edited
Loading

Files changed:

@netlify
Copy link

netlify bot commented Sep 9, 2025 •
edited
Loading

✅ Netlify Preview

Name Link
🔨 Latest commit de54394
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/68f7de63360742000896ccff
😎 Deploy Preview https://deploy-preview-20314--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@rmloveland rmloveland force-pushed the 20250909-DOC-8591-clarify-transaction-pipelining-docs branch from ce0234e to 7ebf84b Compare October 7, 2025 18:38
@rmloveland rmloveland marked this pull request as ready for review October 7, 2025 18:39
@rmloveland rmloveland requested a review from stevendanna October 7, 2025 18:46
@rmloveland
Copy link
Contributor Author

@stevendanna as the reviewer of #19601 (buffered writes) are you also a good reviewer for this update to the transaction pipelining docs? specifically we're correcting some misleading statements about performance that led to a customer filing a support issue (see DOC-8591 for details)

stevendanna
stevendanna approved these changes Oct 17, 2025
View reviewed changes
Copy link
Contributor

@stevendanna stevendanna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, this looks good to me.

One small note is that there seems to be some part-of-speech disagreement in the list of work that is still per-statement.

@rmloveland
Copy link
Contributor Author

One small note is that there seems to be some part-of-speech disagreement in the list of work that is still per-statement.

Thanks for pointing this out, I revised that whole paragraph a bit to simplify it overall as well as hopefully fix the mismatched part of speech phrasing in the list of per-statement work

bsanchez-the-roach
bsanchez-the-roach approved these changes Oct 20, 2025
View reviewed changes
Copy link
Contributor

@bsanchez-the-roach bsanchez-the-roach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't sure if "intent writes" (line 367 in src/current/v25.4/architecture/transaction-layer.md) was a typo or if that's just a synonymous term for "write intents."

Otherwise LGTM.

@rmloveland
Update transaction pipelining docs re: parallelism
7305d6a 
Fixes DOC-8591

Previously, we stated that the cost of writes is ~`O(1)` in the number
of inserts, which is wrong.

The reality is that despite the parallelism introduced by pipelining,
there is other work that happens for each SQL statement write that does
not come "for free".

NB. These changes are ported to all supported versions v23.2+
@rmloveland
Copy link
Contributor Author

I wasn't sure if "intent writes" (line 367 in src/current/v25.4/architecture/transaction-layer.md) was a typo or if that's just a synonymous term for "write intents."

ah thanks! reversed

Thank you both for the reviews - backporting these changes to docs for all supported versions

@rmloveland rmloveland force-pushed the 20250909-DOC-8591-clarify-transaction-pipelining-docs branch from b421d22 to 7305d6a Compare October 21, 2025 19:26
@rmloveland rmloveland enabled auto-merge (squash) October 21, 2025 19:26
@rmloveland rmloveland merged commit b3d9b62 into main Oct 21, 2025
6 checks passed
@rmloveland rmloveland deleted the 20250909-DOC-8591-clarify-transaction-pipelining-docs branch October 21, 2025 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stevendanna stevendanna stevendanna approved these changes

@bsanchez-the-roach bsanchez-the-roach bsanchez-the-roach approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rmloveland @stevendanna @bsanchez-the-roach